Skip to content

PATCH /a/n/action/{Name}/{JobUuid}

Send control commands to a background job

Body Parameters

Name Description Type Required
Cmd Type of command to send (None, Pause, Resume, Stop, Delete, RunOnce, Inactive, Active) #/definitions/jobsCommand
JobId Id of the job string
OwnerId Owner of the job string
RunParameters Parameters used for RunOnce command object
TaskId Id of the associated task string

Body Example

1
2
3
4
5
6
7
{
  "Cmd": "string",
  "JobId": "string",
  "OwnerId": "string",
  "RunParameters": {},
  "TaskId": "string"
}

Response Example (200)

Response Type /definitions/restBackgroundAction

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "CanPause": true,
  "CanStop": true,
  "EndTime": 10,
  "HasProgress": true,
  "JobUuid": "string",
  "Label": "string",
  "Name": "string",
  "Progress": "[Unknown Type number]",
  "StartTime": 10,
  "Status": "string",
  "StatusMessage": "string"
}